Skip to main content

Virtual Account Details

GET /api/v1/VirtualAccounts/:accountNumber/details

Description​

This endpoint allows retrieving details of a virtual account.

Headers:​

  • No specific headers are required.

Path Parameters:​

  • accountNumber: The account number of the virtual account to retrieve details for.

  • version: The version of the API.

URL:​

  • GET: /api/v1/VirtualAccounts/{accountNumber}/details

Response:​

  • 200: Success, returns the details of the specified virtual account.

Error Codes:​

  • 400: Bad request, the request is not valid.

  • 404: Not found, the specified virtual account does not exist.

  • 500: Internal server error, something went wrong while processing the request.

Example Response:​

HTTP/1.1 200 OK
{
  "id": "123",
  "name": "VirtualAccount1",
  "customerId": "1234567890",
  "accountId": "0987654321",
  "createdAt": "2024-02-16T12:00:00Z",
  "updatedAt": "2024-02-17T12:00:00Z"
}

Notes:​

  • This endpoint is useful for retrieving details of a specific virtual account.

  • The response includes the virtual account's details including ID, name, customer ID, account ID, and creation/update timestamps.

Method: GET​

/api/v1/VirtualAccounts/:accountNumber/details

Response: 200​

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /api/v1/VirtualAccounts/:accountNumber/details \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!